DEVOPS-853: check jira issue by andrewg-mira · Pull Request #147 · MiraGeoscience/CI-tools

andrewg-mira · 2025-12-12T16:22:36Z

DEVOPS-853 - Update Jenkinslib -- Jira API for querying issues is deprecated

andrewg-mira · 2025-12-12T18:06:22Z

.github/workflows/reusable-jira-pr_check_issue.yml

+    - name: Check issue key
+      if: ${{ !steps.jira_key_from_title.outputs.issue_key }}
+      run: |
+        echo "Could not determine Jira issue from PR title"


Probably TODO: add exceptions for Dependabot etc PRs.

sebhmg

see suggestion to merge workflows, and use a more specific pattern

.github/workflows/reusable-jira-pr_check_issue.yml

.github/workflows/reusable-jira-pr_add_jira_summary.yml

sebhmg

please, see questions and suggestions

.github/workflows/reusable-jira-pr_add_jira_summary.yml

This reverts commit a4460f1.

.github/workflows/reusable-jira-pr_check_issue.yml

Copilot

Pull request overview

Adds/updates reusable GitHub Actions workflows intended to extract a Jira issue key from a PR/branch, optionally update the PR with the Jira summary, and enforce Jira sprint/status requirements using the newer Jira JQL search endpoint.

Changes:

Added reusable workflow to validate a Jira issue is in an open/future sprint and “In Progress” via Jira REST API v3 JQL search.
Hardened/adjusted the reusable “add Jira summary” workflow trigger conditions and token permissions handling.
Introduced a combined reusable workflow that both updates PR content from Jira and validates Jira status.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 9 comments.

File	Description
`.github/workflows/reusable-jira-pr_check_issue.yml`	New reusable workflow to derive Jira key (currently title-only) and validate sprint/status via Jira JQL search endpoint.
`.github/workflows/reusable-jira-pr_add_jira_summary.yml`	Adds `permissions: {}` and job gating; impacts ability to update PR via GitHub API.
`.github/workflows/reusable-jira-pr_actions.yml`	New “all-in-one” reusable workflow combining issue key extraction, PR update from Jira summary, and status enforcement.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.github/workflows/reusable-jira-pr_check_issue.yml

.github/workflows/reusable-jira-pr_add_jira_summary.yml

.github/workflows/reusable-jira-pr_actions.yml

Copilot · 2026-02-12T21:25:25Z

.github/workflows/reusable-jira-pr_actions.yml

+        response=$(curl -s --request GET \
+                   --url "$JIRA_BASE_URL/rest/api/3/search/jql?jql=$jqlencoded&fields=statusCategory" \
+                   --user "${JIRA_USER_EMAIL}:${JIRA_API_TOKEN}" \
+                   --header 'Accept: application/json' \
+                   --header 'Content-Type: application/json')
+
+        if [ $? -ne 0 ]; then
+            echo "Jira API: error"
+            exit 1
+        fi
+


The Jira API calls use curl -s and only check $?, which won’t catch HTTP 4xx/5xx responses (curl still exits 0). Consider using -fS (or capturing the HTTP status code) and validating the JSON response for Jira errors so the workflow fails reliably on API errors.

Suggested change

response=$(curl -s --request GET \

--url "$JIRA_BASE_URL/rest/api/3/search/jql?jql=$jqlencoded&fields=statusCategory" \

--user "${JIRA_USER_EMAIL}:${JIRA_API_TOKEN}" \

--header 'Accept: application/json' \

--header 'Content-Type: application/json')

if [ $? -ne 0 ]; then

echo "Jira API: error"

exit 1

fi

response=$(curl -fsS --request GET \

--url "$JIRA_BASE_URL/rest/api/3/search/jql?jql=$jqlencoded&fields=statusCategory" \

--user "${JIRA_USER_EMAIL}:${JIRA_API_TOKEN}" \

--header 'Accept: application/json' \

--header 'Content-Type: application/json')

if [ $? -ne 0 ]; then

echo "Jira API: HTTP request failed"

exit 1

fi

if ! echo "$response" | jq -e . > /dev/null 2>&1; then

echo "Jira API: invalid JSON response"

exit 1

fi

using curl -fsS sounds a good suggestion to better capture error cases

.github/workflows/reusable-jira-pr_check_issue.yml

.github/workflows/reusable-jira-pr_actions.yml

sebhmg · 2026-02-12T21:36:09Z

.github/workflows/reusable-jira-pr_actions.yml

+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    outputs:
+      issue_key_from_branch: ${{ steps.issue_key_from_branch.outputs.issue_key }}


Suggested change

issue_key_from_branch: ${{ steps.issue_key_from_branch.outputs.issue_key }}

issue_key: ${{ steps.issue_key_from_title.outputs.issue_key || steps.issue_key_from_branch.outputs.issue_key }}

sugggestion: keep only issue_key, and remove issue_key_from_branch and issue_key_from_title

.github/workflows/reusable-jira-pr_actions.yml

.github/workflows/reusable-jira-pr_check_issue.yml

sebhmg · 2026-02-12T21:46:39Z

.github/workflows/reusable-jira-pr_actions.yml

+        "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/pulls/${{ github.event.pull_request.number }}"
+        > /dev/null
+
+  check_jira_issue:


skip the whole workflow if a dependbot PR

possibly not needed to filter out dependabot PRs, as not finding a JIRA issue it not an error

but could the regex match something from the dependabot branch or PR title, which would then fail when requesting JIRA and thus mark the PR as failed?

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

sebhmg

please see suggestion from slight adjustments

Also, pending question about handling dependabot PRs (or those from Laravel Shift)

sebhmg · 2026-02-13T20:56:22Z

.github/workflows/reusable-jira-pr_actions.yml

+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    outputs:
+      issue_key_from_branch: ${{ steps.issue_key_from_branch.outputs.issue_key }}


sugggestion: keep only issue_key, and remove issue_key_from_branch and issue_key_from_title

sebhmg · 2026-02-13T20:57:01Z

.github/workflows/reusable-jira-pr_actions.yml

+
+    steps:
+
+    - name: Get JIRA summary from branch


Suggested change

- name: Get JIRA summary from branch

- name: Get JIRA issue summary

.github/workflows/reusable-jira-pr_actions.yml

.github/workflows/reusable-jira-pr_add_jira_summary.yml

.github/workflows/reusable-jira-pr_actions.yml

sebhmg · 2026-02-13T21:12:36Z

.github/workflows/reusable-jira-pr_actions.yml

+        response=$(curl -s --request GET \
+                   --url "$JIRA_BASE_URL/rest/api/3/search/jql?jql=$jqlencoded&fields=statusCategory" \
+                   --user "${JIRA_USER_EMAIL}:${JIRA_API_TOKEN}" \
+                   --header 'Accept: application/json' \
+                   --header 'Content-Type: application/json')
+
+        if [ $? -ne 0 ]; then
+            echo "Jira API: error"
+            exit 1
+        fi
+


using curl -fsS sounds a good suggestion to better capture error cases

.github/workflows/reusable-jira-pr_actions.yml

sebhmg · 2026-02-13T21:19:18Z

.github/workflows/reusable-jira-pr_actions.yml

+        "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/pulls/${{ github.event.pull_request.number }}"
+        > /dev/null
+
+  check_jira_issue:


possibly not needed to filter out dependabot PRs, as not finding a JIRA issue it not an error

but could the regex match something from the dependabot branch or PR title, which would then fail when requesting JIRA and thus mark the PR as failed?

github-actions bot changed the title ~~DEVOPS-853 check jira issue~~ DEVOPS-853: check jira issue Dec 12, 2025

andrewg-mira requested a review from sebhmg December 12, 2025 18:04

andrewg-mira commented Dec 12, 2025

View reviewed changes

andrewg-mira added 2 commits December 12, 2025 14:21

DEVOPS-853 check if Jira issue in open or future sprint

da9ef2e

DEVOPS-853 add check for Jira issue In Progress

4d59de0

sebhmg force-pushed the DEVOPS-853-check-jira-issue branch from 10650e3 to 4d59de0 Compare December 12, 2025 19:22

sebhmg requested changes Dec 12, 2025

View reviewed changes

.github/workflows/reusable-jira-pr_check_issue.yml Outdated Show resolved Hide resolved

andrewg-mira added 2 commits December 15, 2025 11:11

DEVOPS-853 only run add_jira_summary on PR open

e1a01be

DEVOPS-853 add check-jira-issue to other workflow file

a4460f1

github-advanced-security bot found potential problems Dec 15, 2025

View reviewed changes

.github/workflows/reusable-jira-pr_add_jira_summary.yml Fixed Show fixed Hide fixed

.github/workflows/reusable-jira-pr_add_jira_summary.yml Fixed Show fixed Hide fixed

sebhmg requested changes Dec 15, 2025

View reviewed changes

andrewg-mira added 3 commits December 19, 2025 11:17

Revert "DEVOPS-853 add check-jira-issue to other workflow file"

228af07

This reverts commit a4460f1.

DEVOPS-853 jira-pr_actions

176016c

DEVOPS-853 do not raise error if issue key not found

656611e

sebhmg reviewed Jan 6, 2026

View reviewed changes

.github/workflows/reusable-jira-pr_check_issue.yml Outdated Show resolved Hide resolved

andrewg-mira force-pushed the DEVOPS-853-check-jira-issue branch 4 times, most recently from 07482e7 to 23cb0e6 Compare January 26, 2026 21:50

DEVOPS-853 use 'issue' instad of 'jira', other fixes

126d427

andrewg-mira force-pushed the DEVOPS-853-check-jira-issue branch 2 times, most recently from aa29b27 to e35cfc1 Compare January 27, 2026 19:39

DEVOPS-853 specify permissions for add_jira_summary

866e558

andrewg-mira force-pushed the DEVOPS-853-check-jira-issue branch from e35cfc1 to 866e558 Compare January 27, 2026 19:45

andrewg-mira added 4 commits January 27, 2026 11:50

DEVOPS-853 fix whitepsace errors

877fe13

DEVOPS-853 more debug output

dc31ac7

DEVOPS-853 outputs, not output

eba0815

DEVOPS-853 fix output from get_issue_key job

2d44066

sebhmg requested a review from Copilot February 12, 2026 21:20

Copilot started reviewing on behalf of sebhmg February 12, 2026 21:21 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

sebhmg requested changes Feb 12, 2026

View reviewed changes

andrewg-mira and others added 2 commits February 13, 2026 11:23

DEVOPS-853 combine get_issue_key steps, and remove unused workflow

7a0cd9f

Apply suggestion from @Copilot

a8216c9

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

sebhmg requested changes Feb 13, 2026

View reviewed changes

DEVOPS-853 some fixes from code review

fc4762d

	issue_key_from_branch: ${{ steps.issue_key_from_branch.outputs.issue_key }}
	issue_key: ${{ steps.issue_key_from_title.outputs.issue_key \|\| steps.issue_key_from_branch.outputs.issue_key }}

	- name: Get JIRA summary from branch
	- name: Get JIRA issue summary

Conversation

andrewg-mira commented Dec 12, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sebhmg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sebhmg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sebhmg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

andrewg-mira commented Dec 12, 2025 •

edited by github-actions bot

Loading